home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / Program.pod < prev    next >
Text File  |  2009-04-29  |  4KB  |  235 lines
  1. =head1 NAME
  2.  
  3. Gnome2::Program - wrapper for GnomeProgram
  4.  
  5. =cut
  6.  
  7. =head1 HIERARCHY
  8.  
  9.   Glib::Object
  10.   +----Gnome2::Program
  11.  
  12.  
  13.  
  14. =cut
  15.  
  16.  
  17. =head1 METHODS
  18.  
  19. =head2 string = $program-E<gt>B<get_app_id> 
  20.  
  21. =head2 string = $program-E<gt>B<get_app_version> 
  22.  
  23. =head2 string = $program-E<gt>B<get_human_readable_name> 
  24.  
  25. =head2 program = Gnome2::Program-E<gt>B<init> ($app_id, $app_version, $module_info=undef, ...)
  26.  
  27. =over
  28.  
  29. =item * $app_id (string) 
  30.  
  31. =item * $app_version (string) 
  32.  
  33. =item * $module_info (scalar) 
  34.  
  35. =item * ... (list) 
  36.  
  37. =back
  38.  
  39.  
  40. The list argument is for property-value pairs.
  41.  
  42.  
  43. =head2 list = $program-E<gt>B<locate_file> ($domain, $file_name, $only_if_exists)
  44.  
  45. =over
  46.  
  47. =item * $domain (Gnome2::FileDomain) 
  48.  
  49. =item * $file_name (string) 
  50.  
  51. =item * $only_if_exists (boolean) 
  52.  
  53. =back
  54.  
  55.  
  56. Returns a list of locations.
  57.  
  58.  
  59. =head2 moduleinfo = Gnome2::Program-E<gt>B<module_load> ($mod_name)
  60.  
  61. =over
  62.  
  63. =item * $mod_name (string) 
  64.  
  65. =back
  66.  
  67. =head2 Gnome2::Program-E<gt>B<module_register> ($module_info)
  68.  
  69. =over
  70.  
  71. =item * $module_info (scalar) 
  72.  
  73. =back
  74.  
  75. =head2 boolean = Gnome2::Program-E<gt>B<module_registered> ($module_info)
  76.  
  77. =over
  78.  
  79. =item * $module_info (scalar) 
  80.  
  81. =back
  82.  
  83. =head2 program or undef = Gnome2::Program-E<gt>B<get_program> 
  84.  
  85.  
  86.  
  87. =cut
  88.  
  89.  
  90. =head1 PROPERTIES
  91.  
  92. =over
  93.  
  94. =item 'app-datadir' (string : readable / writable)
  95.  
  96. Data prefix where this application was installed
  97.  
  98. =item 'app-id' (string : readable)
  99.  
  100. ID string to use for this application
  101.  
  102. =item 'app-libdir' (string : readable / writable)
  103.  
  104. Library prefix where this application was installed
  105.  
  106. =item 'app-prefix' (string : readable / writable)
  107.  
  108. Prefix where this application was installed
  109.  
  110. =item 'app-sysconfdir' (string : readable / writable)
  111.  
  112. Configuration prefix where this application was installed
  113.  
  114. =item 'app-version' (string : readable)
  115.  
  116. Version of this application
  117.  
  118. =item 'create-directories' (boolean : readable / writable / construct-only)
  119.  
  120. Create standard GNOME directories on startup
  121.  
  122. =item 'enable-sound' (boolean : readable / writable)
  123.  
  124. Enable sound on startup
  125.  
  126. =item 'espeaker' (string : readable / writable)
  127.  
  128. How to connect to esd
  129.  
  130. =item 'gnome-datadir' (string : readable / writable / construct-only)
  131.  
  132. Data prefix where GNOME was installed
  133.  
  134. =item 'gnome-libdir' (string : readable / writable / construct-only)
  135.  
  136. Library prefix where GNOME was installed
  137.  
  138. =item 'gnome-path' (string : readable / writable / construct-only)
  139.  
  140. Path in which to look for installed files
  141.  
  142. =item 'gnome-prefix' (string : readable / writable / construct-only)
  143.  
  144. Prefix where GNOME was installed
  145.  
  146. =item 'gnome-sysconfdir' (string : readable / writable / construct-only)
  147.  
  148. Configuration prefix where GNOME was installed
  149.  
  150. =item 'goption-context' (gpointer : readable / writable / construct-only)
  151.  
  152. The goption context pointer that GnomeProgram is using
  153.  
  154. =item 'human-readable-name' (string : readable / writable / construct-only)
  155.  
  156. Human readable name of this application
  157.  
  158. =item 'popt-context' (gpointer : readable)
  159.  
  160. The popt context pointer that GnomeProgram is using
  161.  
  162. =item 'popt-flags' (integer : writable / construct-only)
  163.  
  164. The flags to use for popt
  165.  
  166. =item 'popt-table' (gpointer : writable / construct-only)
  167.  
  168. The table of options for popt
  169.  
  170. =back
  171.  
  172.  
  173.  
  174. =cut
  175.  
  176.  
  177. =head1 ENUMS AND FLAGS
  178.  
  179. =head2 enum Gnome2::FileDomain
  180.  
  181. =over
  182.  
  183. =item * 'unknown' / 'GNOME_FILE_DOMAIN_UNKNOWN'
  184.  
  185. =item * 'libdir' / 'GNOME_FILE_DOMAIN_LIBDIR'
  186.  
  187. =item * 'datadir' / 'GNOME_FILE_DOMAIN_DATADIR'
  188.  
  189. =item * 'sound' / 'GNOME_FILE_DOMAIN_SOUND'
  190.  
  191. =item * 'pixmap' / 'GNOME_FILE_DOMAIN_PIXMAP'
  192.  
  193. =item * 'config' / 'GNOME_FILE_DOMAIN_CONFIG'
  194.  
  195. =item * 'help' / 'GNOME_FILE_DOMAIN_HELP'
  196.  
  197. =item * 'app-libdir' / 'GNOME_FILE_DOMAIN_APP_LIBDIR'
  198.  
  199. =item * 'app-datadir' / 'GNOME_FILE_DOMAIN_APP_DATADIR'
  200.  
  201. =item * 'app-sound' / 'GNOME_FILE_DOMAIN_APP_SOUND'
  202.  
  203. =item * 'app-pixmap' / 'GNOME_FILE_DOMAIN_APP_PIXMAP'
  204.  
  205. =item * 'app-config' / 'GNOME_FILE_DOMAIN_APP_CONFIG'
  206.  
  207. =item * 'app-help' / 'GNOME_FILE_DOMAIN_APP_HELP'
  208.  
  209. =back
  210.  
  211.  
  212.  
  213.  
  214. =cut
  215.  
  216.  
  217. =head1 SEE ALSO
  218.  
  219. L<Gnome2>, L<Glib::Object>
  220.  
  221.  
  222. =cut
  223.  
  224.  
  225. =head1 COPYRIGHT
  226.  
  227. Copyright (C) 2003-2004 by the gtk2-perl team.
  228.  
  229. This software is licensed under the LGPL.  See L<Gnome2> for a full notice.
  230.  
  231.  
  232.  
  233. =cut
  234.  
  235.